home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / MOUSE / HOUREXT / !HourExt / !Help < prev    next >
Text File  |  1994-09-19  |  11KB  |  217 lines
  1. Hourglass Extension version 1.10
  2. © Sam Kington 8th August 1994
  3. This program is freeware, *not* public domain – i.e., I retain copyright (see
  4. “Boring legal message”).
  5. This module will only work with RISC OS 3 or later.
  6.  
  7.  
  8. What this program does
  9. **********************
  10.  
  11.    For a start, this program is essentially one small module, HourExt, which
  12. at about 2300 bytes is considerably smaller than the whole application, which
  13. weighs in at slightly less than 44K, of which most is the source code and
  14. this help file. If you decide you don’t need the whole application cluttering
  15. up your hard disc or floppy or whatever, you can put the module somewhere else
  16. (!System.Modules would be a good place), and RMLoad it in your Boot sequence.
  17. If you decide you don’t want *any* of the application, of course, you can
  18. delete the whole thing. If you want to distribute this program or use it for
  19. your own programs, see “Distribution”.
  20.  
  21.    Anyway, down to what the module does. Basically, it sits in the
  22. background, and when you change the palette it changes the hourglass colours
  23. to match. So if you change the mouse pointer colours, say to black and white
  24. instead of the default dark and light blue, it will change the colour of the
  25. Hourglass to black and white as well.
  26.  
  27.    Actually, you have slightly more choice than that. The hourglass only uses
  28. two colours, and if you take a quick look at the palette you will notice that
  29. there are in fact three different mouse colours: 1, used for the mouse
  30. border, 2, used for the inside, and 3, usually red, used for “alert”-style
  31. pointers such as when you want to copy a file from the CLI. So there is a
  32. special *command, *Hourglass_Colours <sand colour> <background colour>, where
  33. <sand colour> and <background colour> are numbers between 1 and 3, which will
  34. set the colours accordingly. The default setting is Hourglass_Colours 1 2;
  35. experiment until you find your favourite setting.
  36.  
  37.    *Hourglass On|Off|<percentage> will turn the hourglass on or off, or
  38. display the supplied percentage underneath the hourglass. You may already
  39. have a module that supplies a command of the same name, but in practice there
  40. shouldn’t be any conflicts as once a command has been handled by one module,
  41. it won’t be passed onto another module. To ensure *Hourglass gets passed to
  42. HourExt, load it before other modules with the same command.
  43.  
  44.    Note that when you type Hourglass Off, you will not necessarily turn it
  45. off: you have to issue a Hourglass Off for every Hourglass On. Also, if you
  46. set the percentage of the hourglass (say Hourglass Percentage 50), then issue
  47. another Hourglass On, any subsequent Hourglass Percentage calls will be
  48. ineffective until you issue as many Hourglass Offs as you issued Hourglass
  49. Ons after setting the percentage. Issuing a further Hourglass_Off will turn
  50. off the percentage. This is an internal feature of RISC OS, nothing to do
  51. with HourExt.
  52.  
  53.    *Hourglass_LEDs On|Off On|Off will set the state of the LEDs, so
  54. *Hourglass_LEDs On Off would set the first one on and the second one off.
  55.  
  56.    As well as changing the colour of the Hourglass to suit the palette, and
  57. allowing you to muck around with the hourglass, HourExt sets up two filters
  58. which intercept all calls to Wimp_Poll, turning on the Hourglass after
  59. control has been given to a program, and turning it off when they give it
  60. back. The practical upshot is that whenever one application spends too much
  61. time on its own without letting other applications have a turn (and, more
  62. importantly, without letting you do anything), the Hourglass is turned on
  63. until the task gives control back. You can alter the delay before the
  64. hourglass is turned on when an application stops multitasking, with the
  65. command *Hourglass_Delay <time in centiseconds>. *Hourglass_Delay 0 turns off
  66. all multitasking checking.
  67.  
  68.    Finally, HourExt knows about Desktop saves, and will insert the relevent
  69. commands in any Desktop files. However, it needs to know where to load itself
  70. from, and does so by looking at the variable HourExt$Module. If the module is
  71. run by the !HourExt application, this will be set up automatically; however,
  72. if it is RMLoaded from somewhere in a Boot sequence or whatever, the variable
  73. will not be set up. If the variable doesn't exist, the module assumes it was
  74. started as System:Modules.HourExt, which is a sensible default; if you load
  75. it from somewhere else, say !Boot.AutoLoad.HourExt, add *Set HourExt$Module
  76. !Boot.AutoLoad.HourExt to the file you load HourExt in.
  77.  
  78. Limitations
  79. ***********
  80.  
  81.    HourExt turns the hourglass on if the machine stops multitasking for a
  82. defined period, which works most of the time. It also notices if you press
  83. F12, and won’t turn the hourglass on in that case. However, if you select
  84. *Commands from the Task Manager menu, the hourglass will come on, and stay on
  85. until you go back to the desktop.
  86.  
  87.    In general, if you stop multitasking, HourExt will put up an hourglass;
  88. however, if you are actually doing something but not multitasking, as opposed
  89. to a program hogging the machine, then it shouldn’t put up an hourglass.
  90. Unfortunately, it has no way of knowing which is which – and do bear in mind
  91. that this is just a quick program written in a couple of days. You are likely
  92. to have problems with screen captures from Paint, and any single-tasking
  93. program that doesn’t turn off the pointer, which includes most *Info programs
  94. from Acorn User but not most games (I don’t think). If it annoys you, use
  95. *Hourglass_Delay 0 to turn the checking off.
  96.  
  97. Boring legal message
  98. ********************
  99.  
  100.    This application is freeware, that is, it can be distributed freely as
  101. long as only reasonable charges are made for media and distribution. I retain
  102. copyright on all program code and documentation.
  103.  
  104.    This software is supplied “as is”: I make no warranty, expressed or
  105. implied, of the merchantability of this software or its fitness for any
  106. particular purpose. In no circumstances shall I be liable for any damage,
  107. loss of profits, or any indirect or consequential loss arising out of the use
  108. of this software or inability to use this software, even if I have been
  109. advised of the possibility of such loss.
  110.  
  111.    In other words, if your computer crashes, blows up, you lose all your work
  112. etc. all because of HourExt (unlikely I know), don’t blame me.
  113.  
  114. Distribution
  115. ************
  116.  
  117.    The following files should be present in a full version of HourExt (you
  118. may, however, not have the full version):
  119.  
  120. Name        Purpose                       Usefulness
  121. ****************************************************
  122. !Boot                                     Not very
  123. !Run                                      Not very
  124. !Sprites                                  Not very
  125. HourExt     The main module               Essential
  126. ModSource   The source code to the module Slightly
  127. ShortHelp   Help text compaction          Quite
  128. ShortHDocs  Help on ShortHelp             Quite
  129. !Help       This file                      Very
  130. Vsn110      This is version 1.10          Not at all
  131.  
  132. The “Vsn110” file’s only purpose is to show that this is version 1.10 – which
  133. is useful if you’re browsing directory displays, or you have several
  134. different versions. As it is, there is only one (distributed) version of
  135. HourExt. If you remove this file, nothing at all will fail to happen.
  136.  
  137. The only point of the !Boot, !Run, and !Sprites is to make this an
  138. application, so there is a HourExt$Dir variable, so the source code can find
  139. the ShortHelp routines (see below). They also set up HourExt$Module; if you
  140. simply RMLoad the module from a path different from System:Modules.HourExt,
  141. you must set this up yourself (see above).
  142.  
  143. ModSource and ShortHelp are basically the source code of the module; or
  144. rather, ModSource is the source code, and uses routines in ShortHelp.
  145. ShortHelp is a collection of routines which will compact strings using RISC
  146. OS’s internal dictionary, to be re-expanded by *Help. ShortHDocs is
  147. essentially a !Help file for ShortHelp.
  148.  
  149. HourExt is of course the main module, without which the whole thing is
  150. useless.
  151.  
  152. Although I would prefer you distributed all the files together, if you want to
  153. include any of the routines in your own programs (the module or the ShortHelp
  154. routines) you will probably not want to distribute all the almost-useless
  155. files. So here are the conditions for distribution:
  156.    • This file (!Help) must always be distributed with the HourExt module,
  157. complete and unmodified.
  158.    • If you distribute ModSource, you must include ShortHelp (otherwise it
  159. won’t compile). If you don’t include the !Boot etc. files, you will have to
  160. change the ModSource code so it can find ShortHelp (putting it in your Library
  161. should be quite sensible - replace <HourExt$Dir>.ShortHelp by %.ShortHelp).
  162.    • You can however distribute ShortHelp separately from any of the other
  163. files, and use it in your own programs. See the file “ShortHDocs” for more
  164. information.
  165.    • You must distribute !Boot, !Run, !Sprites and Vsn110 together, or not at
  166. all.
  167.  
  168. About all these strange foreign characters in this file
  169. *******************************************************
  170.  
  171.    OK, so if you’re reading this on a PC or a Mac or another strange machine
  172. like that, you may be wondering what all these strange ae things are. Well,
  173. they’re quotes (sorry, there was another one), dashes, ligatures, etc.
  174. Honest. But not on all machines...
  175.    Basically, character sets are only standard up to character 127, which is
  176. basically alphanumerics and a few standard punctuation marks. Foreign
  177. characters, typographical oddities like quotes and ligatures, and other more
  178. obscure symbols are “non-standard”, and each computer often has its own idea
  179. of where they should go in the character set. So don’t worry: even if it’s
  180. hard to read on your current machine, it won’t be on an Acorn machine. It may
  181. look slightly strange if you’re using the System font, however.
  182.    But why am I using these strange characters in the first place? Well,
  183. they’re in the character set and they look nice in an outine font, and I’ve
  184. written a program called Smart Quotes (sorry for the plug) that substitutes
  185. these sort of characters automatically, and I’ve got it turned on at the
  186. moment...
  187.  
  188. How to contact me
  189. *****************
  190.  
  191. All bug-reports, suggestions, comments or indeed any feedback at all will be
  192. welcomed. Here’s how to get to me:
  193.  
  194. E-mail     : 9262861k@arts.gla.ac.uk, 926286ki@udcf.gla.ac.uk during term-time
  195.              These should be OK until June 1996
  196.              At Christmas, Easter and during the summer, you can get me at
  197.              wombat@altern.com, wombat@email.teaser.com or sam@altern.com, in order
  198.              of preference (that is, if mail bounces off one of these or I don’t
  199.              answer within a week send to the next one).
  200.  
  201. Snail-mail : My term-time address, at least until June 1995, is:
  202.              Sam Kington
  203.              Flat 2/1
  204.              44 Hotspur Street
  205.              Glasgow G20 8NL
  206.              SCOTLAND
  207.              
  208.              Again, a backup is the home address – anything that goes here will get
  209.              to me eventually.
  210.              Sam Kington
  211.              Merlhiot
  212.              24420 Savignac les Eglises
  213.              FRANCE
  214.  
  215. Term-time is October to June, with bits off at Christmas (3 weeks) and
  216. Easter (4 weeks).
  217.